Range
Function
This API is used to get parameter range for AI > Setup > Multi-Target-Type Recognition page.
Note:
The Range provides reference information for client UI input limits and API request limits. When sending Get and Set requests, the parameters must be strictly limited according to the Range, otherwise the request may be rejected by the device.
Request Message
Parameter Description
Table 1
| Parameter | Range | Type | Description |
|---|---|---|---|
| channel | “CH1”…”CH1x” “IP_CH1”…” IP_CH1x” “WIFI_CH1”…” WIFI_CH1x” The number of channels depends on the capability of the device. | string array | Each array bit represents a channel with a string. DVR/NVR need. IPC only uses CH1 |
| page_type | “ChannelConfig”, “AlarmConfig” | string | Data used to distinguish between the channel configuration page and the alarm configuration page |
Sample:
POST /API/AI/Setup/PVD/Range HTTP/1.1
{
"version": "1.0",
"data": {"page_type": "ChannelConfig"}
}
Response Message
Parameter Description
Table 2
| Parameter | Range | Type | Description |
|---|---|---|---|
| channel_info | JSON object | Single Channel Information JSON show as follow Table x | |
| page_type | “ChannelConfig”, “AarmConfig” | string | The data used to distinguish between the channel configuration page and the alarm configuration page is only needed when setting |
| channel_max | int | Maximum number of channels |
Table x
| Parameter | Range | Type | Description |
|---|---|---|---|
| CH1 | Json Object | JSON show as followTable 3 | |
| ... | Json Object | ||
| IP_CH1 | Json Object | ||
| ... | Json Object | ||
| WIFI_CH1 | Json Object | ||
| ... | Json Object |
Table 3
| Parameter | Range | Type | Description |
|---|---|---|---|
| mix_rule | bool | If true is set, fields exist in both the custom rule box and the full-screen | |
| sensitivity | 0-100 | int | sensitivity |
| snap_mode | "Default" "RealTimeMode" "IntervalMode" | string | Screenshot mode, IntervalMode JSON show as followTable 4 |
| min_pixel | 64-1080 | int | Minimum pixel value |
| max_pixel | 320-1080 | int | Maximum pixel value |
| detection_type_ex | "Off" "Person" "Bicycle" "Car" "Motorcycle" "Airplane" "Bus" "Train" "Truck" "Boat" "Traffic Light" "Fire Hydrant" "Stop Sign" "Parking Meter" "Parking Meter" "Bench" "Bird" "Dog" "Horse" "Sheep" "Cow" "Elephant" "Bear" "Zebra" "Giraffe" "Backpack" "Umbrella" "Handbag" "Tie" "Suitcase" "Frisbee" "Skis" "Snowboard" "Sports Ball" "Kite" "Baseball Bat" "Baseball Glove" "Skateboard" "Surfboard" "Tennis Racket" "Bottle" "Wine Glass" "Cup" "Fork" "Knife" "Spoon" "Bowl" "Banana" "Apple" "Sandwich" "Orange" "Broccoli" "Carrot" "Hot Dog" "Pizza" "Donut" "Cake" "Chair" "Couch" "Potted Plant" "Bed" "Dining Table" "Toilet" "TV" "Laptop" "Mouse" "Remote" "Keyboard" "Cell Phone" "Microwave" "Oven" "Toaster" "Sink" "Refrigerator" "Book" "Clock" "Vase" "Scissors" "Teddy Bear" "Hair Drier" "Toothbrush" | array | detection type |
| iva_lines | 0 not draw lines 1 draw lines | int | Preview and play back whether lines will appear |
| rule_info | Object | Information JSON show as followTable 5 | |
| mutual_exclusion | "Intrusion" "Region Entrance" "Region Exiting" "LCD" | json array | The set of mutually exclusive functions currently enabled,Note: If there is a mutual exclusion function that is already enabled, it is included in the Get. If it is not enabled or there is no mutual exclusion, it is not necessary to pass this field |
| ptz_operation_support | bool | Supports ptz operation | |
| detection_mode | StaticMode,MotionMode | string | detection type |
| tracking_link | bool | Tracking linkage switch | |
| rule_draw_number | min_len:1 max_len:48 | string | For Web Select a rule box for display |
| default_timeout | 1-120000 | int | Session timeout (range usage) |
Table 4
| Parameter | Range | Type | Description |
|---|---|---|---|
| snap_num | "1" "2" "3" "Unlimited" | string | Screenshot count |
| snap_frequency | int | Screenshot interval, unit s/pic |
Table 5
| Parameter | Range | Type | Description |
|---|---|---|---|
| rule_number1 | Object | Rule number 1,Information JSON show as followTable 6 |
表格 6
| 参数 | 范围 | 类型 | 说明 |
|---|---|---|---|
| detection_range | "FullScreen" "Customize" | string | detection range |
| rule_switch | true, false | bool | /* One byte per channel represents up to 4 rules, 0- off, 1- Use */ (IPC Smart Generation only) |
| sensitivity | 0-100 | int | sensitivity |
| detection_mode | StaticMode，MotionMode | string | detection type |
| detection_type_ex | "Off" "Person" "Bicycle" "Car" "Motorcycle" "Airplane" "Bus" "Train" "Truck" "Boat" "Traffic Light" "Fire Hydrant" "Stop Sign" "Parking Meter" "Parking Meter" "Bench" "Bird" "Dog" "Horse" "Sheep" "Cow" "Elephant" "Bear" "Zebra" "Giraffe" "Backpack" "Umbrella" "Handbag" "Tie" "Suitcase" "Frisbee" "Skis" "Snowboard" "Sports Ball" "Kite" "Baseball Bat" "Baseball Glove" "Skateboard" "Surfboard" "Tennis Racket" "Bottle" "Wine Glass" "Cup" "Fork" "Knife" "Spoon" "Bowl" "Banana" "Apple" "Sandwich" "Orange" "Broccoli" "Carrot" "Hot Dog" "Pizza" "Donut" "Cake" "Chair" "Couch" "Potted Plant" "Bed" "Dining Table" "Toilet" "TV" "Laptop" "Mouse" "Remote" "Keyboard" "Cell Phone" "Microwave" "Oven" "Toaster" "Sink" "Refrigerator" "Book" "Clock" "Vase" "Scissors" "Teddy Bear" "Hair Drier" "Toothbrush" | array | detection type |
| rule_type | "Normal" | string | /* One byte per channel for up to 4 rules, 0- off, 1- Use / (IPC Smart Generation Only) / One byte per channel for up to 4 - Rule type, 0- Regular mode, 1- Guest Mode/Other mode */ (IPC Smart Generation only) |
| rule_rect | Object | rectangle,Information JSON show as followTable 7 | |
| point_num | [min:max] | array | Number of points drawn in the area, minimum 3 points (min), maximum 8 points (max) |
Table 7
| Parameter | Range | Type | Description |
|---|---|---|---|
| x1 | 0-704 | short | x1 coordinate point |
| y1 | 0-576 | short | y1 coordinate point |
| x2 | 0-704 | short | x2 coordinate point |
| y2 | 0-576 | short | y2 coordinate point |
| x3 | 0-704 | short | x3 coordinate point |
| y3 | 0-576 | short | y3 coordinate point |
| x4 | 0-704 | short | x4 coordinate point |
| y4 | 0-576 | short | y4 coordinate point |
| x5 | 0-704 | short | x5 coordinate point |
| y5 | 0-576 | short | y5 coordinate point |
| x6 | 0-704 | short | x6 coordinate point |
| y6 | 0-576 | short | y6 coordinate point |
| x7 | 0-704 | short | x7 coordinate point |
| y7 | 0-576 | short | y7 coordinate point |
| x8 | 0-704 | short | x8 coordinate point |
| y8 | 0-576 | short | y8 coordinate point |
Tips:
The response message of the Range request may not contain all the fields in the above table, and the fields not included indicate that the device does not support this parameter configuration.
Sample:
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": "success",
"data": {
"default_timeout": 30000,
"channel_info": {
"type": "object",
"items": {"CH1": {
"type": "object",
"items": {
"mix_rule": {"type": "bool"},
"sensitivity": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 100,
"default_value": 60
},
"snap_mode": {
"type": "string",
"items": [
"Default",
"RealTimeMode",
"IntervalMode"
]
},
"snap_num": {
"type": "string",
"items": [
"1",
"2",
"3",
"Unlimited"
]
},
"snap_frequency": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 255,
"default_value": 2
},
"max_pixel": {
"type": "int32",
"mode": "r",
"min": 320,
"max": 1080,
"default_value": 320
},
"min_pixel": {
"type": "int32",
"mode": "r",
"min": 64,
"max": 1080,
"default_value": 64
},
"detection_mode": {
"type": "string",
"items": [
"HybridMode",
"MotionMode"
]
},
"detection_type_ex": {
"type": "array",
"min_size": 1,
"max_size": 80,
"items": {
"type": "string",
"items": [
"Person",
"Bicycle",
"Car",
"Motorcycle",
"Airplane",
"Bus",
"Train",
"Truck",
"Boat",
"Traffic Light",
"Fire Hydrant",
"Stop Sign",
"Parking Meter",
"Bench",
"Bird",
"Cat",
"Dog",
"Horse",
"Sheep",
"Cow",
"Elephant",
"Bear",
"Zebra",
"Giraffe",
"Backpack",
"Umbrella",
"Handbag",
"Tie",
"Suitcase",
"Frisbee",
"Skis",
"Snowboard",
"Sports Ball",
"Kite",
"Baseball Bat",
"Baseball Glove",
"Skateboard",
"Surfboard",
"Tennis Racket",
"Bottle",
"Wine Glass",
"Cup",
"Fork",
"Knife",
"Spoon",
"Bowl",
"Banana",
"Apple",
"Sandwich",
"Orange",
"Broccoli",
"Carrot",
"Hot Dog",
"Pizza",
"Donut",
"Cake",
"Chair",
"Couch",
"Potted Plant",
"Bed",
"Dining Table",
"Toilet",
"TV",
"Laptop",
"Mouse",
"Remote",
"Keyboard",
"Cell Phone",
"Microwave",
"Oven",
"Toaster",
"Sink",
"Refrigerator",
"Book",
"Clock",
"Vase",
"Scissors",
"Teddy Bear",
"Hair Drier",
"Toothbrush"
]
}
},
"rule_info": {
"type": "object",
"items": {
"rule_number1": {
"type": "object",
"items": {
"detection_range": {
"type": "string",
"items": [
"FullScreen",
"UserDefined"
]
},
"rule_switch": {"type": "bool"},
"sensitivity": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 100,
"default_value": 60
},
"detection_mode": {
"type": "string",
"items": [
"HybridMode",
"MotionMode"
]
},
"detection_type_ex": {
"type": "array",
"min_size": 1,
"max_size": 80,
"items": {
"type": "string",
"items": [
"Person",
"Bicycle",
"Car",
"Motorcycle",
"Airplane",
"Bus",
"Train",
"Truck",
"Boat",
"Traffic Light",
"Fire Hydrant",
"Stop Sign",
"Parking Meter",
"Bench",
"Bird",
"Cat",
"Dog",
"Horse",
"Sheep",
"Cow",
"Elephant",
"Bear",
"Zebra",
"Giraffe",
"Backpack",
"Umbrella",
"Handbag",
"Tie",
"Suitcase",
"Frisbee",
"Skis",
"Snowboard",
"Sports Ball",
"Kite",
"Baseball Bat",
"Baseball Glove",
"Skateboard",
"Surfboard",
"Tennis Racket",
"Bottle",
"Wine Glass",
"Cup",
"Fork",
"Knife",
"Spoon",
"Bowl",
"Banana",
"Apple",
"Sandwich",
"Orange",
"Broccoli",
"Carrot",
"Hot Dog",
"Pizza",
"Donut",
"Cake",
"Chair",
"Couch",
"Potted Plant",
"Bed",
"Dining Table",
"Toilet",
"TV",
"Laptop",
"Mouse",
"Remote",
"Keyboard",
"Cell Phone",
"Microwave",
"Oven",
"Toaster",
"Sink",
"Refrigerator",
"Book",
"Clock",
"Vase",
"Scissors",
"Teddy Bear",
"Hair Drier",
"Toothbrush"
]
}
},
"point_num": {
"type": "array",
"size": 2,
"items": []
},
"rule_rect": {
"type": "object",
"items": {
"x1": {
"type": "int32",
"min": 0,
"max": 704
},
"x2": {
"type": "int32",
"min": 0,
"max": 704
},
"x3": {
"type": "int32",
"min": 0,
"max": 704
},
"x4": {
"type": "int32",
"min": 0,
"max": 704
},
"x5": {
"type": "int32",
"min": 0,
"max": 704
},
"x6": {
"type": "int32",
"min": 0,
"max": 704
},
"x7": {
"type": "int32",
"min": 0,
"max": 704
},
"x8": {
"type": "int32",
"min": 0,
"max": 704
},
"y1": {
"type": "int32",
"min": 0,
"max": 576
},
"y2": {
"type": "int32",
"min": 0,
"max": 576
},
"y3": {
"type": "int32",
"min": 0,
"max": 576
},
"y4": {
"type": "int32",
"min": 0,
"max": 576
},
"y5": {
"type": "int32",
"min": 0,
"max": 576
},
"y6": {
"type": "int32",
"min": 0,
"max": 576
},
"y7": {
"type": "int32",
"min": 0,
"max": 576
},
"y8": {
"type": "int32",
"min": 0,
"max": 576
}
}
}
}
},
"rule_number2": {
"type": "object",
"items": {
"detection_range": {
"type": "string",
"items": [
"FullScreen",
"UserDefined"
]
},
"rule_switch": {"type": "bool"},
"sensitivity": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 100,
"default_value": 60
},
"detection_mode": {
"type": "string",
"items": [
"HybridMode",
"MotionMode"
]
},
"detection_type_ex": {
"type": "array",
"min_size": 1,
"max_size": 80,
"items": {
"type": "string",
"items": [
"Person",
"Bicycle",
"Car",
"Motorcycle",
"Airplane",
"Bus",
"Train",
"Truck",
"Boat",
"Traffic Light",
"Fire Hydrant",
"Stop Sign",
"Parking Meter",
"Bench",
"Bird",
"Cat",
"Dog",
"Horse",
"Sheep",
"Cow",
"Elephant",
"Bear",
"Zebra",
"Giraffe",
"Backpack",
"Umbrella",
"Handbag",
"Tie",
"Suitcase",
"Frisbee",
"Skis",
"Snowboard",
"Sports Ball",
"Kite",
"Baseball Bat",
"Baseball Glove",
"Skateboard",
"Surfboard",
"Tennis Racket",
"Bottle",
"Wine Glass",
"Cup",
"Fork",
"Knife",
"Spoon",
"Bowl",
"Banana",
"Apple",
"Sandwich",
"Orange",
"Broccoli",
"Carrot",
"Hot Dog",
"Pizza",
"Donut",
"Cake",
"Chair",
"Couch",
"Potted Plant",
"Bed",
"Dining Table",
"Toilet",
"TV",
"Laptop",
"Mouse",
"Remote",
"Keyboard",
"Cell Phone",
"Microwave",
"Oven",
"Toaster",
"Sink",
"Refrigerator",
"Book",
"Clock",
"Vase",
"Scissors",
"Teddy Bear",
"Hair Drier",
"Toothbrush"
]
}
},
"point_num": {
"type": "array",
"size": 2,
"items": []
},
"rule_rect": {
"type": "object",
"items": {
"x1": {
"type": "int32",
"min": 0,
"max": 704
},
"x2": {
"type": "int32",
"min": 0,
"max": 704
},
"x3": {
"type": "int32",
"min": 0,
"max": 704
},
"x4": {
"type": "int32",
"min": 0,
"max": 704
},
"x5": {
"type": "int32",
"min": 0,
"max": 704
},
"x6": {
"type": "int32",
"min": 0,
"max": 704
},
"x7": {
"type": "int32",
"min": 0,
"max": 704
},
"x8": {
"type": "int32",
"min": 0,
"max": 704
},
"y1": {
"type": "int32",
"min": 0,
"max": 576
},
"y2": {
"type": "int32",
"min": 0,
"max": 576
},
"y3": {
"type": "int32",
"min": 0,
"max": 576
},
"y4": {
"type": "int32",
"min": 0,
"max": 576
},
"y5": {
"type": "int32",
"min": 0,
"max": 576
},
"y6": {
"type": "int32",
"min": 0,
"max": 576
},
"y7": {
"type": "int32",
"min": 0,
"max": 576
},
"y8": {
"type": "int32",
"min": 0,
"max": 576
}
}
}
}
},
"rule_number3": {
"type": "object",
"items": {
"detection_range": {
"type": "string",
"items": [
"FullScreen",
"UserDefined"
]
},
"rule_switch": {"type": "bool"},
"sensitivity": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 100,
"default_value": 60
},
"detection_mode": {
"type": "string",
"items": [
"HybridMode",
"MotionMode"
]
},
"detection_type_ex": {
"type": "array",
"min_size": 1,
"max_size": 80,
"items": {
"type": "string",
"items": [
"Person",
"Bicycle",
"Car",
"Motorcycle",
"Airplane",
"Bus",
"Train",
"Truck",
"Boat",
"Traffic Light",
"Fire Hydrant",
"Stop Sign",
"Parking Meter",
"Bench",
"Bird",
"Cat",
"Dog",
"Horse",
"Sheep",
"Cow",
"Elephant",
"Bear",
"Zebra",
"Giraffe",
"Backpack",
"Umbrella",
"Handbag",
"Tie",
"Suitcase",
"Frisbee",
"Skis",
"Snowboard",
"Sports Ball",
"Kite",
"Baseball Bat",
"Baseball Glove",
"Skateboard",
"Surfboard",
"Tennis Racket",
"Bottle",
"Wine Glass",
"Cup",
"Fork",
"Knife",
"Spoon",
"Bowl",
"Banana",
"Apple",
"Sandwich",
"Orange",
"Broccoli",
"Carrot",
"Hot Dog",
"Pizza",
"Donut",
"Cake",
"Chair",
"Couch",
"Potted Plant",
"Bed",
"Dining Table",
"Toilet",
"TV",
"Laptop",
"Mouse",
"Remote",
"Keyboard",
"Cell Phone",
"Microwave",
"Oven",
"Toaster",
"Sink",
"Refrigerator",
"Book",
"Clock",
"Vase",
"Scissors",
"Teddy Bear",
"Hair Drier",
"Toothbrush"
]
}
},
"point_num": {
"type": "array",
"size": 2,
"items": []
},
"rule_rect": {
"type": "object",
"items": {
"x1": {
"type": "int32",
"min": 0,
"max": 704
},
"x2": {
"type": "int32",
"min": 0,
"max": 704
},
"x3": {
"type": "int32",
"min": 0,
"max": 704
},
"x4": {
"type": "int32",
"min": 0,
"max": 704
},
"x5": {
"type": "int32",
"min": 0,
"max": 704
},
"x6": {
"type": "int32",
"min": 0,
"max": 704
},
"x7": {
"type": "int32",
"min": 0,
"max": 704
},
"x8": {
"type": "int32",
"min": 0,
"max": 704
},
"y1": {
"type": "int32",
"min": 0,
"max": 576
},
"y2": {
"type": "int32",
"min": 0,
"max": 576
},
"y3": {
"type": "int32",
"min": 0,
"max": 576
},
"y4": {
"type": "int32",
"min": 0,
"max": 576
},
"y5": {
"type": "int32",
"min": 0,
"max": 576
},
"y6": {
"type": "int32",
"min": 0,
"max": 576
},
"y7": {
"type": "int32",
"min": 0,
"max": 576
},
"y8": {
"type": "int32",
"min": 0,
"max": 576
}
}
}
}
},
"rule_number4": {
"type": "object",
"items": {
"detection_range": {
"type": "string",
"items": [
"FullScreen",
"UserDefined"
]
},
"rule_switch": {"type": "bool"},
"sensitivity": {
"type": "int32",
"mode": "r",
"min": 1,
"max": 100,
"default_value": 60
},
"detection_mode": {
"type": "string",
"items": [
"HybridMode",
"MotionMode"
]
},
"detection_type_ex": {
"type": "array",
"min_size": 1,
"max_size": 80,
"items": {
"type": "string",
"items": [
"Person",
"Bicycle",
"Car",
"Motorcycle",
"Airplane",
"Bus",
"Train",
"Truck",
"Boat",
"Traffic Light",
"Fire Hydrant",
"Stop Sign",
"Parking Meter",
"Bench",
"Bird",
"Cat",
"Dog",
"Horse",
"Sheep",
"Cow",
"Elephant",
"Bear",
"Zebra",
"Giraffe",
"Backpack",
"Umbrella",
"Handbag",
"Tie",
"Suitcase",
"Frisbee",
"Skis",
"Snowboard",
"Sports Ball",
"Kite",
"Baseball Bat",
"Baseball Glove",
"Skateboard",
"Surfboard",
"Tennis Racket",
"Bottle",
"Wine Glass",
"Cup",
"Fork",
"Knife",
"Spoon",
"Bowl",
"Banana",
"Apple",
"Sandwich",
"Orange",
"Broccoli",
"Carrot",
"Hot Dog",
"Pizza",
"Donut",
"Cake",
"Chair",
"Couch",
"Potted Plant",
"Bed",
"Dining Table",
"Toilet",
"TV",
"Laptop",
"Mouse",
"Remote",
"Keyboard",
"Cell Phone",
"Microwave",
"Oven",
"Toaster",
"Sink",
"Refrigerator",
"Book",
"Clock",
"Vase",
"Scissors",
"Teddy Bear",
"Hair Drier",
"Toothbrush"
]
}
},
"point_num": {
"type": "array",
"size": 2,
"items": []
},
"rule_rect": {
"type": "object",
"items": {
"x1": {
"type": "int32",
"min": 0,
"max": 704
},
"x2": {
"type": "int32",
"min": 0,
"max": 704
},
"x3": {
"type": "int32",
"min": 0,
"max": 704
},
"x4": {
"type": "int32",
"min": 0,
"max": 704
},
"x5": {
"type": "int32",
"min": 0,
"max": 704
},
"x6": {
"type": "int32",
"min": 0,
"max": 704
},
"x7": {
"type": "int32",
"min": 0,
"max": 704
},
"x8": {
"type": "int32",
"min": 0,
"max": 704
},
"y1": {
"type": "int32",
"min": 0,
"max": 576
},
"y2": {
"type": "int32",
"min": 0,
"max": 576
},
"y3": {
"type": "int32",
"min": 0,
"max": 576
},
"y4": {
"type": "int32",
"min": 0,
"max": 576
},
"y5": {
"type": "int32",
"min": 0,
"max": 576
},
"y6": {
"type": "int32",
"min": 0,
"max": 576
},
"y7": {
"type": "int32",
"min": 0,
"max": 576
},
"y8": {
"type": "int32",
"min": 0,
"max": 576
}
}
}
}
}
}
},
"rule_draw_number": {
"type": "string",
"min_len": 1,
"max_len": 48
},
"draw_add_btn": {
"type": "object",
"items": {"visible": {"type": "bool"}}
},
"btn_get_default_data": true
}
}}
}
}
}
Error Code
See Response Messages Body and Common error_code for more information.